<!--

     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
     regarding copyright ownership.  The ASF licenses this file
     to you under the Apache License, Version 2.0 (the
     "License"); you may not use this file except in compliance
     with the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing,
     software distributed under the License is distributed on an
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
     under the License.

-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- **************************************************************** -->
<!-- *  PLEASE KEEP COMPLICATED EXPRESSIONS OUT OF THESE TEMPLATES, * -->
<!-- *  i.e. only iterate & print data where possible. Thanks, Jez. * -->
<!-- **************************************************************** -->

<html>
<head>
    <!-- Generated by groovydoc (2.4.5) on Mon Sep 12 08:35:18 CEST 2016 -->
    <title>Job (Groovy Documentation)</title>
    <meta name="date" content="2016-09-12">
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <link href="../../../../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
    <link href="../../../../../../groovy.ico" type="image/x-icon" rel="icon">
    <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">

<body class="center">
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
    parent.document.title="Job (Groovy Documentation)";
}
//-->
</script>
<noscript>
    <div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
    <!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
    <!--   -->
</a>
    <ul class="navList" title="Navigation">
        <li><a href="../../../../../../overview-summary.html">Overview</a></li>
        <li><a href="package-summary.html">Package</a></li>
        <li class="navBarCell1Rev">Class</li>
        <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
        <li><a href="../../../../../../index-all.html">Index</a></li>
        <li><a href="../../../../../../help-doc.html">Help</a></li>
    </ul>
</div>

<div class="subNav">
    <div>
        <ul class="navList">
            <li><a href="../../../../../../index.html?io/vertx/groovy/ext/shell/system/Job" target="_top">Frames</a></li>
            <li><a href="Job.html" target="_top">No Frames</a></li>
        </ul>
    </div>
    <div>
        <ul class="subNavList">
            <li>Summary:&nbsp;</li>
            Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_summary">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
        <ul class="subNavList">
            <li>&nbsp;|&nbsp;Detail:&nbsp;</li>
            Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_detail">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
    </div>
    <a name="skip-navbar_top">
        <!--   -->
    </a></div>
<!-- ========= END OF TOP NAVBAR ========= -->

<!-- ======== START OF CLASS DATA ======== -->
<div class="header">

    <div class="subTitle">Package: <strong>io.vertx.groovy.ext.shell.system</strong></div>

    <h2 title="[Groovy] Class Job" class="title">[Groovy] Class Job</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><ul class="inheritance"></ul></li><li>io.vertx.groovy.ext.shell.system.Job
</ul>
<div class="description">
    <ul class="blockList">
        <li class="blockList">



    <p> A job executed in a <a href='../../../../../../io/vertx/groovy/ext/shell/system/JobController.html' title='JobController'>JobController</a>, grouping one or several process.<p/>

 The job life cycle can be controlled with the <a href='../../../../../../io/vertx/groovy/ext/shell/system/Job.html#run' title='Job.run'>Job.run</a>, <a href='../../../../../../io/vertx/groovy/ext/shell/system/Job.html#resume' title='Job.resume'>Job.resume</a> and <a href='../../../../../../io/vertx/groovy/ext/shell/system/Job.html#suspend' title='Job.suspend'>Job.suspend</a> and <a href='../../../../../../io/vertx/groovy/ext/shell/system/Job.html#interrupt' title='Job.interrupt'>Job.interrupt</a>
 methods.
</p>

          </li>
    </ul>
</div>

<div class="summary">
    <ul class="blockList">
        <li class="blockList">
        <!-- =========== NESTED CLASS SUMMARY =========== -->
        

        <!-- =========== ENUM CONSTANT SUMMARY =========== -->
        
        <!-- =========== FIELD SUMMARY =========== -->
        

        <!-- =========== PROPERTY SUMMARY =========== -->
        

        <!-- =========== ELEMENT SUMMARY =========== -->
        

        
        <!-- ======== CONSTRUCTOR SUMMARY ======== -->
        <ul class="blockList">
                <li class="blockList"><a name="constructor_summary"><!--   --></a>
                    <h3>Constructor Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructors Summary table">
                        <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Constructor and description</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst">
                                <code><a href="#Job(java.lang.Object)">Job</a></strong>
                                (java.lang.Object delegate)</code><br></td>
                        </tr>
                        
                    </table>
                   </ul>
              </li>
        </ul>
        

        
        <!-- ========== METHOD SUMMARY =========== -->
        <ul class="blockList">
            
            <li class="blockList"><a name="method_summary"><!--   --></a>
                    <h3>Methods Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Methods Summary table">
                        <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Type</th>
                            <th class="colLast" scope="col">Name and description</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>java.lang.Object</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getDelegate()">getDelegate</a></strong>()</code><br></td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>int</strong></code></td>
                            <td class="colLast"><code><strong><a href="#id()">id</a></strong>()</code><br>@return the job id</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>boolean</strong></code></td>
                            <td class="colLast"><code><strong><a href="#interrupt()">interrupt</a></strong>()</code><br>Attempt to interrupt the job.</td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>long</strong></code></td>
                            <td class="colLast"><code><strong><a href="#lastStopped()">lastStopped</a></strong>()</code><br>@return when the job was last stopped</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>java.lang.String</strong></code></td>
                            <td class="colLast"><code><strong><a href="#line()">line</a></strong>()</code><br>@return the execution line of the job, i.e the shell command line that launched this job</td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/shell/system/Process.html'>Process</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#process()">process</a></strong>()</code><br>@return the first process in the job</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/shell/system/Job.html'>Job</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#resume()">resume</a></strong>()</code><br>Resume the job to foreground.
 </td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/shell/system/Job.html'>Job</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#resume(boolean)">resume</a></strong>(boolean foreground)</code><br>Resume the job.</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/shell/system/Job.html'>Job</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#run()">run</a></strong>()</code><br>Run the job, before running the job a  must be set.</td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/shell/system/Job.html'>Job</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#setSession(io.vertx.groovy.ext.shell.session.Session)">setSession</a></strong>(<a href='../../../../../../io/vertx/groovy/ext/shell/session/Session.html'>Session</a> session)</code><br>Set a session on the job.</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/shell/system/Job.html'>Job</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#setTty(io.vertx.groovy.ext.shell.term.Tty)">setTty</a></strong>(<a href='../../../../../../io/vertx/groovy/ext/shell/term/Tty.html'>Tty</a> tty)</code><br>Set a tty on the job.</td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../../../../ExecStatus.html'>ExecStatus</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#status()">status</a></strong>()</code><br>@return the job exec status</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/shell/system/Job.html'>Job</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#statusUpdateHandler(Handler<ExecStatus>)">statusUpdateHandler</a></strong>(io.vertx.core.Handler&lt;ExecStatus&gt; handler)</code><br>Set an handler called when the job terminates.</td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/shell/system/Job.html'>Job</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#suspend()">suspend</a></strong>()</code><br>Resume the job.</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>void</strong></code></td>
                            <td class="colLast"><code><strong><a href="#terminate()">terminate</a></strong>()</code><br>Terminate the job.</td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/shell/system/Job.html'>Job</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#toBackground()">toBackground</a></strong>()</code><br>Send the job to background.</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/shell/system/Job.html'>Job</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#toForeground()">toForeground</a></strong>()</code><br>Send the job to foreground.</td>
                        </tr>
                        
                    </table>
                   </ul>
              </li>
            
            <li class="blockList"><a name="method_summary"><!--   --></a>
                    <h3>Inherited Methods Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Inherited Methods Summary table">
                        <caption><span>Inherited Methods</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Methods inherited from class</th>
                            <th class="colLast" scope="col">Name</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>class java.lang.Object</strong></code></td>
                            <td class="colLast"><code>java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()</code></td>
                        </tr>
                    </table>
                   </ul>
              </li>
                
        </ul>
        
    </li>
    </ul>
</div>

<div class="details">
    <ul class="blockList">
        <li class="blockList">
           

            

            

            

            
            <!-- =========== CONSTRUCTOR DETAIL =========== -->
            <ul class="blockList">
                <li class="blockList"><a name="constructor_detail">
                    <!--   -->
                </a>
                    <h3>Constructor Detail</h3>
                    
                        <a name="Job(java.lang.Object)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><strong>Job</strong>(java.lang.Object delegate)</h4>
                                <p></p>
                            </li>
                        </ul>
                    
                </li>
            </ul>
            


            
            <!-- =========== METHOD DETAIL =========== -->
            <ul class="blockList">
                <li class="blockList"><a name="method_detail">
                    <!--   -->
                </a>
                    <h3>Method Detail</h3>
                    
                        <a name="getDelegate()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>java.lang.Object <strong>getDelegate</strong>()</h4>
                                <p></p>
                            </li>
                        </ul>
                    
                        <a name="id()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>int <strong>id</strong>()</h4>
                                <p>
   <DL><DT><B>Returns:</B></DT><DD>the job id</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="interrupt()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>boolean <strong>interrupt</strong>()</h4>
                                <p> Attempt to interrupt the job.
   <DL><DT><B>Returns:</B></DT><DD>true if the job is actually interrupted</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="lastStopped()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>long <strong>lastStopped</strong>()</h4>
                                <p>
   <DL><DT><B>Returns:</B></DT><DD>when the job was last stopped</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="line()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>java.lang.String <strong>line</strong>()</h4>
                                <p>
   <DL><DT><B>Returns:</B></DT><DD>the execution line of the job, i.e the shell command line that launched this job</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="process()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/shell/system/Process.html'>Process</a> <strong>process</strong>()</h4>
                                <p>
   <DL><DT><B>Returns:</B></DT><DD>the first process in the job</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="resume()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/shell/system/Job.html'>Job</a> <strong>resume</strong>()</h4>
                                <p> Resume the job to foreground. <DL><DT><B>Returns:</B></DT><DD></DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="resume(boolean)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/shell/system/Job.html'>Job</a> <strong>resume</strong>(boolean foreground)</h4>
                                <p> Resume the job. <DL><DT><B>Returns:</B></DT><DD></DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>foreground</code> -  true when the job is resumed in foreground</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="run()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/shell/system/Job.html'>Job</a> <strong>run</strong>()</h4>
                                <p> Run the job, before running the job a  must be set.
   <DL><DT><B>Returns:</B></DT><DD>this object</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="setSession(io.vertx.groovy.ext.shell.session.Session)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/shell/system/Job.html'>Job</a> <strong>setSession</strong>(<a href='../../../../../../io/vertx/groovy/ext/shell/session/Session.html'>Session</a> session)</h4>
                                <p> Set a session on the job.
   <DL><DT><B>Returns:</B></DT><DD>this object</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>session</code> -  the session to use</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="setTty(io.vertx.groovy.ext.shell.term.Tty)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/shell/system/Job.html'>Job</a> <strong>setTty</strong>(<a href='../../../../../../io/vertx/groovy/ext/shell/term/Tty.html'>Tty</a> tty)</h4>
                                <p> Set a tty on the job.
   <DL><DT><B>Returns:</B></DT><DD>this object</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>tty</code> -  the tty to use</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="status()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../ExecStatus.html'>ExecStatus</a> <strong>status</strong>()</h4>
                                <p>
   <DL><DT><B>Returns:</B></DT><DD>the job exec status</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="statusUpdateHandler(Handler<ExecStatus>)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/shell/system/Job.html'>Job</a> <strong>statusUpdateHandler</strong>(io.vertx.core.Handler&lt;ExecStatus&gt; handler)</h4>
                                <p> Set an handler called when the job terminates.
   <DL><DT><B>Returns:</B></DT><DD>this object</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>handler</code> -  the terminate handler</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="suspend()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/shell/system/Job.html'>Job</a> <strong>suspend</strong>()</h4>
                                <p> Resume the job.
   <DL><DT><B>Returns:</B></DT><DD>this object</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="terminate()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>void <strong>terminate</strong>()</h4>
                                <p> Terminate the job.
   </p>
                            </li>
                        </ul>
                    
                        <a name="toBackground()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/shell/system/Job.html'>Job</a> <strong>toBackground</strong>()</h4>
                                <p> Send the job to background.
   <DL><DT><B>Returns:</B></DT><DD>this object</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="toForeground()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/shell/system/Job.html'>Job</a> <strong>toForeground</strong>()</h4>
                                <p> Send the job to foreground.
   <DL><DT><B>Returns:</B></DT><DD>this object</DD></DL></p>
                            </li>
                        </ul>
                    
                </li>
            </ul>
            
        </li>
    </ul>
</div>

<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
    <!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
    <!--   -->
</a>
    <ul class="navList" title="Navigation">
        <li><a href="../../../../../../overview-summary.html">Overview</a></li>
        <li><a href="package-summary.html">Package</a></li>
        <li class="navBarCell1Rev">Class</li>
        <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
        <li><a href="../../../../../../index-all.html">Index</a></li>
        <li><a href="../../../../../../help-doc.html">Help</a></li>
    </ul>
</div>

<div class="subNav">
    <div>
        <ul class="navList">
            <li><a href="../../../../../../index.html?io/vertx/groovy/ext/shell/system/Job" target="_top">Frames</a></li>
            <li><a href="Job.html" target="_top">No Frames</a></li>
        </ul>
    </div>
    <div>
        <ul class="subNavList">
            <li>Summary:&nbsp;</li>
            Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_summary">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
        <ul class="subNavList">
            <li>&nbsp;|&nbsp;Detail:&nbsp;</li>
            Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_detail">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
    </div>
    <p>Groovy Documentation</p>
    <a name="skip-navbar_bottom">
        <!--   -->
    </a>
    </div>
</div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>